home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / bbs / tdk_v136.zip / SYSOP.DOC < prev    next >
Text File  |  1997-07-22  |  20KB  |  416 lines
  1. * FEEL FREE TO INCLUDE THIS DOCUMENT WITH EVERY DOOR YOU WRITE *
  2.  
  3. * MODIFY AS NEEDED *
  4.  
  5. ───────────────────────────────────────────────────────────────────────────────
  6.    ▀▀▀▀▀▀▀▀  ▀▀▀▀▀▀    ▀▀   ▀▀
  7.      ▀▀     ▀▀   ▀▀   ▀▀  ▀▀
  8.     ▀▀     ▀▀   ▀▀▀  ▀▀▀▀▀  The DoorKit!
  9.    ▀▀     ▀▀   ▀▀   ▀▀  ▀▀
  10.   ▀▀     ▀▀▀▀▀▀    ▀▀    ▀▀
  11.   The BBS Door Development Kit By The People - For The People!
  12. ───────────────────────────────────────────────────────────────────────────────
  13.   The ANSI/ASCII/RIP/MAX DoorKit v1.35
  14.   No Copyright Notices Expressed Or Implied
  15.   Compiled By Larry L. Athey From Numerous Sources
  16. ───────────────────────────────────────────────────────────────────────────────
  17.  
  18.   DISCLAIMER:
  19.   -----------
  20.   The author (Your Name) has taken every precaution to insure that no harm or
  21.   damage will occur on computer systems operating this package. Nevertheless,
  22.   the author shall NOT be held liable for whatever may happen on your computer
  23.   system or to any computer systems which connects to your own as a result of
  24.   operating this package. The user assumes full responsibility for the correct
  25.   operation of this software package, whether harm or damage results from any
  26.   software error, hardware malfunction, or operator error. NO warranties are
  27.   offered, expressly stated or implied, including without any limitation or
  28.   restriction any warranties of operation for a particular purpose and / or
  29.   merchantability. If you do not agree with this, then absolutely do NOT use
  30.   this program!
  31.  
  32. ───────────────────────────────────────────────────────────────────────────────
  33.  
  34.   LICENSE AGREEMENT:
  35.   ------------------
  36.  
  37.   The door program, support files, and documentation are copyrighted products
  38.   of (Your Software Company). The author reserves all rights to these products.
  39.   This is protected by the United States of America (USA) and International
  40.   Copyright Laws. In no way shall the components of the door software package
  41.   be reproduced or modified in any form or method without prior expressly
  42.   written permission from the author.
  43.  
  44.   Tampering with or altering the contents or integrity of the door software
  45.   package is prohibited. No fee may be charged by any agency other than the
  46.   author beyond the cost of distributing unregistered copies without prior
  47.   expressly written permission from the author.
  48.  
  49.   This door is distributed under the Shareware concept. You are allowed to
  50.   operate this door for a trial period of thirty (30) days. After this trial
  51.   period, you must register the door or discontinue its usage. Again if you
  52.   do not agree with this, then do NOT use this door!
  53.  
  54. ───────────────────────────────────────────────────────────────────────────────
  55.  
  56.   GUARANTEE:
  57.   ----------
  58.   Ha Ha Ha Ha....Guarantee? Okay, if this program breaks, I guarantee that you
  59.   get to keep both pieces....How's that?  :)
  60.  
  61. ───────────────────────────────────────────────────────────────────────────────
  62.  
  63.   REQUIREMENTS:
  64.   -------------
  65.  (Add your program system requirements here...)
  66.  
  67.   This door is 100 percent ANSI, ASCII, AVATAR, RIP and MAX aware.
  68.  
  69. ───────────────────────────────────────────────────────────────────────────────
  70.  
  71.   INSTALLATION:
  72.   -------------
  73.  
  74.  1. Create a directory for the door (example: "C:\DOOR").
  75.  
  76.  2. Copy all the contents of this archive into that directory.
  77.  
  78.  3. Run the door configuration program.
  79.  
  80.  4. To insure proper multi-node use in a DOS based multi-tasking environment,
  81.     SHARE.EXE must be installed prior to the door, and prior to the OS.
  82.  
  83.  5. In order to run the door program online, the following parameters may
  84.     be used. For a list of all available command line parameters, simply
  85.     execute the door program with no parameters on the command line....
  86.  
  87.     DropFile Specifiers:
  88.     --------------------
  89.     "/D={Node Work Path}\DOOR.SYS" - This tells the program to use the
  90.     DOOR.SYS drop file and the {Node Work Path} points to the proper
  91.     directory where the drop file is to be created or found.
  92.  
  93.     "/R={Node Work Path}\DORINFO#.DEF" - This tells the program to use the
  94.     DORINFO#.DEF drop file and the {Node Work Path} points to the proper
  95.     directory where the drop file is to be created or found.
  96.  
  97.     "/M={Node Work Path}\MX_USER.DAT" - This tells the program to use the
  98.     MX_USER.DAT drop file and the {Node Work Path} points to the proper
  99.     directory where the drop file is to be created or found.
  100.  
  101.     Optional Parameters:
  102.     --------------------
  103.     "/P={MAXterm Home Directory}" - If this door supports MAX Graphics and
  104.     MAX pseudo network spool operation, this parameter is used to start up
  105.     the spool and point it to the directory where MAXterm is installed. You
  106.     may only use this in conjunction with the /L parameter.
  107.  
  108.     "/S##### (Where ##### is the user's actual baud rate) - This specifies
  109.     the online caller's actual baud rate. You use this parameter to force a
  110.     new baud rate if you are running the door with the DOOR.SYS drop file
  111.     and would like to force the door to use the actual baud rate rather than
  112.     the locked port speed.
  113.  
  114.     "/N###" (Where ### is 1..?) - This specifies the current node number and
  115.     tells the door which NODE###.CTL file to use.
  116.  
  117.     "/L" - This tells the door to load up in LOCAL mode.
  118.  
  119.     "/O" - This tells the door to load up in ONLINE mode. This is useful if
  120.     you are running the door online without a drop file. Such is the case if
  121.     you wanted to run the door between your BBS and a front end mailer or a
  122.     waiting for caller program where no drop files are created in advance.
  123.     
  124.     "/X" - This tells the door to send a !|1K|*|#|#|# at exit time to either
  125.     clear the remote screen in RIPterm or to flip MAXterm back to text mode.
  126.  
  127.     "/U#####" (Where ##### is the user's actual BBS record number) - This is
  128.     used in the event the door needs to know the user's actual record number
  129.     when it is not contained in the drop file, or if no drop file is in use.
  130.  
  131.     "/A#####" (Where ##### is the user's actual BBS access level) - This is
  132.     used in the event the door needs to know the user's actual access level
  133.     when it is not contained in the drop file, or if no drop file is in use.
  134.  
  135.     "/T#####" (Where ##### is the user's remaining time in minutes) - This
  136.     is used in the event the door needs to know the user's actual remaining
  137.     online time when it is not contained in the drop file, or if no drop
  138.     file is in use.
  139.  
  140.     "/E#####" (Where ##### is the number of minutes until your next event)
  141.     This is used in the event the door needs to know when the next event in
  142.     your BBS is to take place when it is not contained in the drop file, or
  143.     if no drop file is in use.
  144.  
  145.     "/Z[FirstName_LastName]" - This is used in the event that you have to
  146.     force the user's name and alias in the door. If there is a first name
  147.     and last name, they must be separated by an underscore, not a space..
  148.  
  149.     "/CONFIG" - This is used only in the event that this door has built in
  150.     configuration routines. If the door has none, then this parameter will
  151.     kick back an error and halt the program.
  152.  
  153. ───────────────────────────────────────────────────────────────────────────────
  154.  
  155.   THE CONTROL FILE EDITOR:
  156.   ------------------------
  157.  
  158.     ┌─────────────────────────────────────────────────────────────────────┐
  159.     │ Editing Control File For Node #1                                    │
  160.     ├─────────────────────────────────────────────────────────────────────┤
  161.     │ SysOp First Name:[Your First Name_____]                             │
  162.     │  SysOp Last Name:[Your Last Name______]                             │
  163.     │ Name Of This BBS:[Your BBS Name___________________________]         │
  164.     │   SysOp Security:[500__]                                            │
  165.     │    Serial Number:[__________]                                       │
  166.     │    BBS Home Path:[C:\MX\______]                                     │
  167.     │─────────────────────────────────────────────────────────────────────│
  168.     │     Using Fossil:[Y]         Input Buffer Size:[4096]               │
  169.     │ Locked Port Rate:[38400_]   Output Buffer Size:[4096]               │
  170.     │   Digi Over Ride:[N]         Non-Standard Port:[N]        Save ▄    │
  171.     │   Comm Data Bits:[8]            Comport Number:[1_]       ▀▀▀▀▀▀    │
  172.     │      Comm Parity:[N]           Port IRQ Number:[4_]       Quit ▄    │
  173.     │   Comm Stop Bits:[1]          Port Hex Address:[03F8]     ▀▀▀▀▀▀    │
  174.     └─────────────────────────────────────────────────────────────────────┘
  175.  
  176.     SysOp First Name: Self Explanatory
  177.      SysOp Last Name: "              "
  178.     Name Of This BBS: "              "
  179.  
  180.       SysOp Security: Set this to the same numeric value as the sysop
  181.                       security level on your BBS.
  182.  
  183.        Serial Number: Enter the serial number here that you are issued
  184.                       when registering this program. Repeat this step
  185.                       for every node.
  186.  
  187.        BBS Home Path: Enter the path to your BBS home directory here.
  188.                       This has nothing to do with drop files, the path
  189.                       to your drop files is passed on the command line.
  190.                       this is used so this program can locate your BBS
  191.                       system data files.
  192.  
  193.         Using Fossil: Are you using a fossil driver? [Y/N]
  194.  
  195.     Locked Port Rate: Enter the speed here in which your comport is
  196.                       locked at.
  197.  
  198.       Digi Over Ride: Do you want this program to use DigiBoard over
  199.                       ride comm routines? [Y/N]
  200.  
  201.       Comm Data Bits: Set to the same as your BBS's Data Bits setting.
  202.  
  203.          Comm Parity: Set to the same as your BBS's Parity setting.
  204.                       N=None, O=Odd, E=Even
  205.  
  206.       Comm Stop Bits: Set to the same as your BBS's Stop Bits setting.
  207.  
  208.    Input Buffer Size: Set this to the same as your BBS or fossil driver.
  209.  
  210.   Output Buffer Size: Set this to the same as your BBS or fossil driver.
  211.  
  212.    Non-Standard Port: Are you using a non-standard IRQ setting? [Y/N]
  213.  
  214.       Comport Number: The comport number for this node (If Non-Standard).
  215.  
  216.      Port IRQ Number: The IRQ number for this node (If Non-Standard).
  217.  
  218.     Port Hex Address: This port's address in hex (If Non-Standard).
  219.  
  220. ───────────────────────────────────────────────────────────────────────────────
  221.  
  222.   SAMPLE BATCH FILES FOR RUNNING THE DOOR:
  223.   ----------------------------------------
  224.   CD\DOOR
  225.   DOOR.EXE /D=C:\BBS\NODE1\DOOR.SYS
  226.   CD\BBS
  227.   EXIT
  228.  
  229.   or:
  230.  
  231.   CD\DOOR
  232.   DOOR.EXE /N2 /S14400 /R=C:\BBS\NODE2\DORINFO2.DEF
  233.   CD\BBS
  234.   EXIT
  235.  
  236. ───────────────────────────────────────────────────────────────────────────────
  237.  
  238.   OTHER GENERAL INFORMATION:
  239.   --------------------------
  240.  
  241.   Global System Variables Used By The Door:
  242.   ─────────────────────────────────────────
  243.   {TIME}      = The Current Time
  244.   {DATE}      = The Current Date
  245.   {NODE}      = The Current Node Number
  246.   {BAUD}      = The Current Baud Rate
  247.   {MINS}      = Time Left Online In Minutes
  248.   {EVENT}     = Minutes Until Next Event
  249.   {PORT}      = The Current Comm Port In Use
  250.   {SEC}       = The User's Security Level
  251.   {BBS}       = Your BBS Name
  252.   {USER}      = User's Full Name
  253.   {SYSOP}     = SysOp's Full Name
  254.   {UFIRST}    = User's First Name
  255.   {ULAST}     = User's Last Name
  256.   {SFIRST}    = SysOp's First Name
  257.   {SLAST}     = SysOp's Last Name
  258.   {PROG}      = The Program Name and Version Number
  259.   {ADDR}      = The Port Address Stored In The .CTL File
  260.   {IRQ}       = The Port IRQ Stored In The .CTL File
  261.   {SYSSEC}    = SysOp Security Stored In The .CTL File
  262.   {SERIAL}    = The Serial Number Stored In The .CTL File
  263.   {INSERT1}
  264.    Through
  265.   {INSERT5}   = These are system variables that change from
  266.                 time to time through out the program. Check
  267.                 your screen files to see what their purpose
  268.                 is at the time.
  269.  
  270.   These variables can also be used in text files and screen files used by
  271.   your program. You will also want to look at your ANSI and RIP files with
  272.   a text editor to make sure that any Global System Variables you have used
  273.   have not been split as this will cause them to display incorrectly.
  274.  
  275.   There is a neat little feature incorporated in the variables called Padding
  276.   that is used to allign text on your screen, or to ensure that variables will
  277.   only take up X amount of characters on the screen. Any underscores "_" in a
  278.   variable are translated into spaces at run time and can be used on either
  279.   side of the variable. The way to look at it is a "Pad Left" and "Pad Right"
  280.   sort of feature.
  281.  
  282.   Let's try an experiment with the {USER} variable, we'll just use some
  283.   short strings of text to demonstrate the usage of variables and padding.
  284.   Let's say that the user's real name is "Jimi Hendrix". (Just because...)
  285.  
  286.     Actual Text: Hello {USER}, how are you today?
  287.   Translates To: Hello Jimi Hendrix, how are you today?
  288.  
  289.     Actual Text: Hello {USER________________________}, how are you today?
  290.   Translates To: Hello Jimi Hendrix                  , how are you today?
  291.  
  292.     Actual Text: Hello {________________________USER}, how are you today?
  293.   Translates To: Hello                   Jimi Hendrix, how are you today?
  294.  
  295.   Now, granted that these aren't really practical examples, but it shows you
  296.   how padded and non-padded variables work. Padding would be especially handy
  297.   if you were creating something like a user statistics screen. You could put
  298.   the padded variables on an ANSI background, and since there is padding in
  299.   there, the screen will always be displayed in a uniformed fashion. As you
  300.   can see in the above example, the variable {USER} is padded so there is a
  301.   total of 30 spaces on the screen. If you were to chop it down to 20, even
  302.   if the user's name was longer than 20 characters, only 20 characters will
  303.   be displayed on the screen at once.
  304.  
  305.   If you have ever noticed with other programs that use variables of any kind,
  306.   to make sure that your screens always display perfectly alligned is to use
  307.   ANSI animation to go to a specific X/Y coordinate and then plot the variable
  308.   on whatever backdrop you are using. Guess what?....ASCII callers are out of
  309.   luck in this case because there is no cursor control in ACSII/TTY emulation.
  310.  
  311.   Inline Color Tokens:
  312.   ────────────────────
  313.   Inline Color Tokens are similar to Global System Variables with just one
  314.   exception....They don't work in screen files. These are used for adding
  315.   color to text files. Your ANSI colors range from 0 to 31, any number above
  316.   15 forces ANSI blink on. If you want to change the color anywhere in a text
  317.   file, simply add a color code in a pair of fancy brackets before your text.
  318.   An example would be, to change your text to yellow add the token: {14} just
  319.   before it. You have as many color changes that you can fit into a 256
  320.   character line. Padding has no effect on inline color tokens.
  321.  
  322. ───────────────────────────────────────────────────────────────────────────────
  323.  
  324.   MULTINODE USE:
  325.   --------------
  326.  
  327.   This door supports multinode use and provides automatic multi-tasker
  328.   support (time slice releasing) for a wide variety of multi-taskers.
  329.   Such as DesqView, OS/2, and Windows. You will need to run the program
  330.   configuration to create all of the needed control files and node work
  331.   directories. The only thing left to do after that is create batch files
  332.   for each node.
  333.  
  334. ───────────────────────────────────────────────────────────────────────────────
  335.  
  336.   TROUBLESHOOTING:
  337.   ----------------
  338.  
  339.  1. This door DOES NOT REQUIRE a fossil driver to run correctly.
  340.  
  341.  2. If you are running a high speed modem (9600 baud or above), then I
  342.     suggest you run your BBS/Mailer/Doors at a locked baud rate. On high
  343.     speed error correcting modems, locking the baud rate will have a
  344.     noticable increase on the speed of text that is sent. It's beyond
  345.     the scope of this document to discuss configuring your BBS and
  346.     mailer for a locked baud rate, you may wish to consult your BBS docs
  347.     for information on that. Here are a couple things to keep in mind
  348.     when setting up door with a locked baud rate:
  349.  
  350.     a.  If you are using a fossil, then make sure to tell the fossil
  351.         that the port is locked. For BNU, to lock com1: at 38,400, you
  352.         would use something like "L0=38400,8N1" on BNU's command line.
  353.  
  354.     b.  If you lock the baud for one program, it must be locked for
  355.         everything. You can't lock the baud for just this door, but
  356.         not your BBS/Mailer.
  357.  
  358.  3. What follows is some information on possible strange situations
  359.     that may occur on some systems:
  360.  
  361.     a.  Low speed users can use the door, but high speed users get garbage.
  362.  
  363.         - If you are the DORINFOx.DEF drop file, then there is a chance
  364.           your BBS is writing the locked port speed to the drop file
  365.           rather than the actual caller baud rate. You should either
  366.           change to the DOOR.SYS drop file, or use the /S parameter to
  367.           pass the actual baud rate to the door.
  368.  
  369.           Several converter programs are readily available on most
  370.           BBS systems. CallDoor is a good one if you can find it.
  371.  
  372.     b.  The door hangs up when a user enters the door.
  373.  
  374.         - Sounds like the door is getting the wrong baud rate somehow.
  375.           Try switching over to the DOOR.SYS drop file method if possible.
  376.  
  377.         - This can also be cause by using a fossil driver and locking the
  378.           comport at a rate higher than 38400. If this is the case, then
  379.           reduce your locked port speed and try again.
  380.  
  381.     c.  Text and screens are getting cut off.
  382.  
  383.         - If you are running with a locked baud, then this could be caused
  384.           by some sort of FLOW CONTROL problem. Make sure your fossil is
  385.           loaded correctly and not locked faster than 38400 baud.
  386.  
  387.         - If you're using something other than the DOOR.SYS drop file,
  388.           then I always suggest trying to use DOOR.SYS if possible. It is
  389.           the most reliable method and has had the most testing. If that
  390.           is not possible try DORINFOx.DEF as an alternative.
  391.  
  392.     d.  The door locks up the BBS on every node.
  393.  
  394.         - This can happen with fossil driver or the internal communications
  395.           routines because it uses the default comport of 1 when NONE or
  396.           COM0: is found in the drop file.
  397.  
  398.     e.  ANSI is reflected correctly on the local screen but the user is
  399.         getting garbage when using DORINFOx.DEF.
  400.  
  401.         - Assuming the user has ANSI installed then most likely the problem
  402.           is at your end. First make sure the dropfile is passing the actual
  403.           baud rate INSTEAD of the locked port speed. If it is not passing
  404.           correct baud rate then you may need to use DOOR.SYS instead.
  405.  
  406.     f.  When a user enters the door or when you run it locally, the screen
  407.         appears to cycle (flipping) over and over until the program shuts
  408.         down with a "Runtime Error 202".
  409.  
  410.         - This is caused by people running hacked versions of their fossil
  411.           driver. Even though most of these hacks are nothing more than a
  412.           copy with a new version number, once it's tampered with, it's a
  413.           defective copy. Programs to avoid are BNU 2.xx and X00 2.xx. If
  414.           at all possible, get your fossil drivers author direct!
  415.  
  416.